From: Daniel Boles <dboles@src.gnome.org>
Date: Fri, 12 Jan 2018 21:26:36 +0000 (+0000)
Subject: Window: Mention GtkHeaderBar in set_titlebar() doc
X-Git-Tag: archive/raspbian/3.24.39-1+rpi1~1^2~65^2~38^2~63
X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/success/%22http:/www.example.com/cgi/success?a=commitdiff_plain;h=fe220402cbc55533d4c95a7d713319c7daac59bd;p=gtk%2B3.0.git

Window: Mention GtkHeaderBar in set_titlebar() doc

This is the typical thing passed here and what most users want, so we
should mention it here, rather than requiring users to figure it out.
---

diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c
index d4bc48c2e1..c6aa5425ff 100644
--- a/gtk/gtkwindow.c
+++ b/gtk/gtkwindow.c
@@ -4173,6 +4173,9 @@ on_titlebar_title_notify (GtkHeaderBar *titlebar,
  *
  * Sets a custom titlebar for @window.
  *
+ * A typical widget used here is #GtkHeaderBar, as it provides various features
+ * expected of a titlebar while allowing the addition of child widgets to it.
+ *
  * If you set a custom titlebar, GTK+ will do its best to convince
  * the window manager not to put its own titlebar on the window.
  * Depending on the system, this function may not work for a window